Switch from using rubric in release notes #1346
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1346 +/- ##
=======================================
Coverage 84.44% 84.44%
=======================================
Files 36 36
Lines 5747 5747
=======================================
Hits 4853 4853
Misses 894 894 |
|
Good call! We should also make sure that people can link to patch versions. For some reason, anchors like |
I have a local commit for this The problem is that sphinx can't do ids that start with numbers, so I added "Version". I would also like to keep the date out of it so it just looks like https://anndata.readthedocs.io/en/latest/release-notes/index.html#version-0-10-5 But that might require putting the date on a separate line, which I'd rather not do. |
|
Yeah, that would be great! Mabye we can define the |
| # Don’t allow broken links. DO NOT CHANGE THIS LINE, fix problems instead. | ||
| app.warningiserror = True |
There was a problem hiding this comment.
By now, this is enforced in .readthedocs.yml
Having it twice helped against the most egregious offenders, but by now I’m in a more active role and can prevent the other instance from being removed.
| @@ -1,8 +1,45 @@ | |||
| # Release notes | |||
|
|
|||
| ```{include} /release-notes/release-latest.md | |||
| (v0.11)= | |||
There was a problem hiding this comment.
the v is load-bearing, without it the generated HTML anchors are generic id40 ones as mentioned above.
We could also use myst_heading_slug_func
There was a problem hiding this comment.
this release doesn’t actually exist
Co-authored-by: Isaac Virshup <[email protected]>
Just something that always bothered me. Plus if we want to put release notes on github it'd be nice to have less that needs reformatting.